/*
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 *    Obfuscate.java
 *    Copyright (C) 2002 University of Waikato
 *
 */


package pATT.filters.unsupervised.attribute;


import pATT.core.Attribute;
import pATT.core.FastVector;
import pATT.core.Instance;
import pATT.core.Instances;
import pATT.core.Utils;
import pATT.filters.Filter;
import pATT.filters.StreamableFilter;
import pATT.filters.UnsupervisedFilter;


/** 
 * A simple instance filter that renames the relation, all attribute names
 * and all nominal (and string) attribute values. For exchanging sensitive
 * datasets. Currently doesn't like string attributes.
 *
 * @author Len Trigg (len@reeltwo.com)
 * @version $Revision: 1.2 $
 */
@SuppressWarnings("serial")
public class Obfuscate extends Filter implements UnsupervisedFilter,
						 StreamableFilter {

  /**
   * Returns a string describing this filter
   *
   * @return a description of the filter suitable for
   * displaying in the explorer/experimenter gui
   */
  public String globalInfo() {
    return "An instance filter that obfuscates all strings in the data";
  }

  /**
   * Sets the format of the input instances.
   *
   * @param instanceInfo an Instances object containing the input instance
   * structure (any instances contained in the object are ignored - only the
   * structure is required).
   * @return true if the outputFormat may be collected immediately
   */
  public boolean setInputFormat(Instances instanceInfo) throws Exception {

    super.setInputFormat(instanceInfo);
    
    // Make the obfuscated header
    FastVector v = new FastVector();
    for (int i = 0; i < instanceInfo.numAttributes(); i++) {
      Attribute oldAtt = instanceInfo.attribute(i);
      Attribute newAtt = null;
      switch (oldAtt.type()) {
      case Attribute.NUMERIC:
        newAtt = new Attribute("A" + (i + 1));
        break;
      case Attribute.NOMINAL:
        FastVector vals = new FastVector();
        for (int j = 0; j < oldAtt.numValues(); j++) {
          vals.addElement("V" + (j + 1));
        }
        newAtt = new Attribute("A" + (i + 1), vals);
        break;
      case Attribute.STRING:
      default:
        newAtt = (Attribute) oldAtt.copy();
        System.err.println("Not converting attribute: " + oldAtt.name());
        break;
      }
      v.addElement(newAtt);
    }
    Instances newHeader = new Instances("R", v, 10);
    setOutputFormat(newHeader);
    return true;
  }


  /**
   * Input an instance for filtering. Ordinarily the instance is processed
   * and made available for output immediately. Some filters require all
   * instances be read before producing output.
   *
   * @param instance the input instance
   * @return true if the filtered instance may now be
   * collected with output().
   * @exception IllegalStateException if no input format has been set.
   */
  public boolean input(Instance instance) {

    if (getInputFormat() == null) {
      throw new IllegalStateException("No input instance format defined");
    }
    if (m_NewBatch) {
      resetQueue();
      m_NewBatch = false;
    }
    push((Instance)instance.copy());
    return true;
  }

  /**
   * Main method for testing this class.
   *
   * @param argv should contain arguments to the filter: use -h for help
   */
  public static void main(String [] argv) {
    
    try {
      if (Utils.getFlag('b', argv)) {
	Filter.batchFilterFile(new Obfuscate(), argv);
      } else {
	Filter.filterFile(new Obfuscate(), argv);
      }
    } catch (Exception ex) {
      System.out.println(ex.getMessage());
    }
  }
  
  @Override
  public boolean isSupervisedFilter() {
  	return false;
  }

  @Override
  public boolean isAttributeFilter() {
  	return true;
  }

  @Override
  public String moreInfo() {
  	return globalInfo();
  }

  @Override
  public boolean hasDataInput() {
  	return false;
  }

@Override
public String more() {
	return super.more(null);
}

@Override
public String getOption(String label) {
	return "";
}

@Override
public void cleanFields() {
	
	
}
  
}








